home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 1999 #2 / Amiga Plus CD - 1999 - No. 2.iso / System-Boost / Workbench / ToolManager / Docs / english / ToolManager.txt next >
Text File  |  1998-06-17  |  46KB  |  1,345 lines
  1. ToolManager 3.1 Documentation
  2. *****************************
  3.  
  4. Copyright and other legal stuff
  5. *******************************
  6.  
  7.    Permission is granted to make and distribute verbatim copies of this
  8. manual provided the copyright notice and this permission notice are
  9. preserved on all copies.
  10.  
  11. COPYRIGHT
  12.  
  13.    Copyright (C) 1990-1998 Stefan Becker
  14.  
  15.    No program, document, data file or source code from this software
  16. package, neither in whole nor in part, may be included or used in other
  17. software packages unless it is authorized by a written permission from
  18. the author.
  19.  
  20. NO WARRANTY
  21.  
  22.    There is no warranty for this software package. Although the author
  23. has tried to prevent errors he can't guarantee that the software package
  24. described in this document is 100% reliable. You are therefore using
  25. this material at your own risk. The author cannot be made responsible
  26. for any damage which is caused by using this software package.
  27.  
  28. DISTRIBUTION
  29.  
  30.    This software package is freely distributable. It may be transfered
  31. to any media which is used for the distribution of free software like
  32. Public Domain disk collections, CDROMs, FTP servers or bulletin board
  33. systems.
  34.  
  35.    In order to ensure the integrity of this software package
  36. distributors should use the original archive files:
  37.  
  38. ToolManager3_1Binaries.lha  (file name on Aminet: ToolManagerBin.lha)
  39. ToolManager3_1Developer.lha (file name on Aminet: ToolManagerDev.lha)
  40. ToolManager3_1Extras.lha    (file name on Aminet: ToolManagerExt.lha)
  41. ToolManager3_1Locale.lha    (file name on Aminet: ToolManagerLoc.lha)
  42. ToolManager3_1Sources.lha   (file name on Aminet: ToolManagerSrc.lha)
  43.  
  44.    The author cannot be made responsible if this software package has
  45. become unusable due to modifications of the archive contents or of the
  46. archive files itself.
  47.  
  48.    There is no limit on the fee taken by distributors, e.g. for the
  49. media costs of floppy disks, streamer tapes or compact discs, or the
  50. process of duplicating. Such limits have proven to be harmful to the
  51. idea of freely distributable software, e.g. the software package was
  52. removed instead of reducing the price of a floppy disk below the limit.
  53.  
  54.    Although the author does not impose any limit on these fees he would
  55. like to express his personal opinions on this matter:
  56.  
  57.    * This software package should be made available to everyone free of
  58.      charge whenever this is possible.
  59.  
  60.    * If you have purchased this software package under normal conditions
  61.      from a Public Domain dealer on a floppy disk and have paid more
  62.      than 5 DM or US $5 then you have definitely paid too much.
  63.      Please don't support this improper profit making any longer and
  64.      switch to a cheaper source as soon as possible.
  65.  
  66. USAGE RESTRICTIONS
  67.  
  68.    No program, document, data file or source code from this software
  69. package, neither in whole nor in part, may be used on any machine which
  70. is used
  71.  
  72.    * for the research, development, construction, testing or production
  73.      of weapons or other military applications. This also includes any
  74.      machine which is used in the education for any of the above
  75.      mentioned purposes.
  76.  
  77.    * by people who accept, support or use violence against other people,
  78.      e.g. citizens from foreign countries.
  79.  
  80. If you like ToolManager...
  81. **************************
  82.  
  83.    ToolManager is GiftWare, not ShareWare!
  84.  
  85.    So if you like the program and use it very often, you should
  86. consider to send a little donation or gift to honor the work that I
  87. have put into this program. I suggest a donation of US $10-$20 or 10-20
  88. DM. Please don't send cheques or money orders from outside Europe,
  89. because most often cashing those items costs more than what they amount
  90. to.
  91.  
  92.    If can't affort to send a donation you don't have to feel bad about
  93. it.  But you have to send me at least a postcard or letter saying that
  94. you are using ToolManager (I like to get fan mail :-). See Author.
  95.  
  96. About the future of ToolManager
  97. *******************************
  98.  
  99.    Since the last major release of ToolManager 2.1 in May 1993 it has
  100. been a troubled time for the Amiga and its user community. At the time
  101. of this writing the future still doesn't look too optimistic. Despite
  102. of this I have decided to develop a new version of ToolManager 3.0,
  103. because of the enormous feedback I got from hundreds of satisfied users.
  104.  
  105.    My trustworthy A3000 is now getting old and with the current
  106. situation it is uncertain which direction the Amiga will take. I can't
  107. afford to buy every upgrade or any of the (eventually) new machines,
  108. because this project is only my hobby. Thus it depends on your feedback
  109. and donations if I'm able to work on future versions of ToolManager.
  110.  
  111.    This is also a call to the companies which are working on the future
  112. Amigas (Amiga Technologies, Phase5, ProDAD, VisCorp or whoever is
  113. currently involved).  I'm only a FD author and can't afford to buy
  114. every possible system or to pay the developer material for every
  115. system. So I need your support if you wan't to see ToolManager running
  116. on your system. Remember that ToolManager is one of (if not the)
  117. most-used tools on the Amiga and therefore it will be a bonus for your
  118. system.
  119.  
  120.    The future of ToolManager depends on YOUR support!
  121.  
  122. Where to send bug reports, comments & donations
  123. ***********************************************
  124.  
  125.    The author can be reached at the following addresses:
  126.  
  127. Post address:
  128.  
  129.                   Stefan Becker
  130.                   Bonner Ring 68
  131.           D-50374 Erfstadt
  132.                   GERMANY
  133.  
  134. Electronic Mail:
  135.  
  136.           stefanb@yello.ping.de
  137.  
  138.    There is also a ToolManager homepage available in the World Wide Web:
  139.  
  140.      http://www.ping.de/sites/yello/toolmanager.html
  141.  
  142. What is required to run ToolManager?
  143. ************************************
  144.  
  145.    ToolManager needs at least:
  146.  
  147. AmigaOS 3.0 (V39)
  148.      or better for memory pools and the picture.datatype.
  149.  
  150. WBStart 2.2
  151.      This enables ToolManager to start Workbench programs.
  152.  
  153. DOSPath 1.0
  154.      This enables ToolManager to handle AmigaDOS paths.
  155.  
  156.    Additionally it supports:
  157.  
  158. ScreenNotify 1.0
  159.      This package enables ToolManager to open and close its dock
  160.      windows when public screens open or close.
  161.  
  162. picture.datatype V43
  163.      The extensions of this enhanced picture.datatype are automatically
  164.      supported if it is installed on your system. See Credits.
  165.  
  166.    The Preferences editor requires:
  167.  
  168. AmigaOS 3.0 (V39)
  169.      or better for memory pools.
  170.  
  171. MUI 3.7
  172.      The object-oriented GUI system. See MUI.
  173.  
  174. Pophotkey, Popport, Popposition
  175.      MUI custom classes for popups. See Credits.
  176.  
  177. How to install ToolManager
  178. **************************
  179.  
  180.    Please use the supplied Installer script to install ToolManager. It
  181. requires the AmigaOS Installer V43.3. This version can be found on the
  182. Aminet.
  183.  
  184.    Make sure that you quit the old ToolManager first before installing
  185. the new version!
  186.  
  187. Concepts behind ToolManager
  188. ***************************
  189.  
  190.    ToolManager is a program which lets you start your tools in a very
  191. easy way.  You can start programs by using keyboard shortcuts (see
  192. Hotkeys), by selecting an entry from the Workbench's Tools menu or by
  193. clicking an icon either on the Workbench or in special dock windows.
  194. You can even drag icons from Workbench drawers on those icons to supply
  195. files to the programs.  Additionally you can attach a sound to each of
  196. these actions.
  197.  
  198.    All these things are controlled by ToolManager objects. Each object
  199. has a specific task and contains information how to accomplish this
  200. task. F.ex.  programs are represented as Exec objects and contain
  201. information about the program name and the stack size.
  202.  
  203.    There are two types of objects. The object types Exec, Image and
  204. Sound are called basic objects, because they only contain information
  205. about one program, one image and one sound.
  206.  
  207.    The object types Menu, Icon and Dock are called compound objects,
  208. because they bind several basic objects together to perform their
  209. tasks. F.ex. an icon on the Workbench is represented by an Icon object
  210. which has a link to an Image object for the icon imagery and a link to
  211. an Exec object which will start a program when the icon is activated.
  212.  
  213. Programs
  214. ========
  215.  
  216.    An Exec object contains information about a program which is started
  217. when the object is activated. The object can be activated directly by
  218. the user using a Hotkeys or through a compund object. On activation a
  219. set of files can be supplied which are forwarded to the program as
  220. startup parameters. Exec objects are configured with the ExecWindow.
  221.  
  222.    ToolManager can execute different kinds of programs:
  223.  
  224. Shell
  225.      The program is executed as shell program just as the user had
  226.      typed in the command line into the shell. Shell scripts have to be
  227.      started in this mode. You can use the usual [] place holders to
  228.      specify where the file arguments should be placed on the command
  229.      line.
  230.  
  231. Workbench
  232.      A start from the Workbench is simulated. All files are supplied as
  233.      Workbench arguments. Shell-only programs and shell scripts will
  234.      not work when started as Workbench program.
  235.  
  236. ARexx
  237.      An ARexx script or command is executed.
  238.  
  239. Dock
  240.      The command specifies a ToolManager Dock object which should be
  241.      activated. You can use this program type to create docks which are
  242.      embedded in other docks.
  243.  
  244. Hotkey
  245.      A hotkey is generated. This might be used to control another
  246.      program from ToolManager.
  247.  
  248. Images
  249. ======
  250.  
  251.    An Image object contains information about an image which is used by
  252. a compund object. ToolManager can load Workbench icons which are used
  253. by Icon objects. When a Dock objects uses an Image object the data is
  254. loaded using the DataTypes system. Thus ToolManager can use every image
  255. for which you have a valid datatype installed on your system. Image
  256. objects are configured with the ImageWindow.
  257.  
  258. Sounds
  259. ======
  260.  
  261.    A Sound object contains information about a sound command. This
  262. sound command is sent as an ARexx command to an external sound player.
  263. Sound objects are configured with the SoundWindow.
  264.  
  265. Entries in the Workbench Tools menu
  266. ===================================
  267.  
  268.    A Menu object is a compound object which binds an Exec objects and a
  269. Sound objects together to create an entry in the Workbench Tools menu.
  270. Whenever this menu entry is selected the Exec object and the Sound
  271. object are activated. Every selected icon on the Workbench is used as
  272. startup parameter for the program. Menu objects are configured with the
  273. MenuWindow.
  274.  
  275. Icons in the Workbench window
  276. =============================
  277.  
  278.    An Icon object is a compound object which binds an Exec objects, an
  279. Image objects and a Sound objects together to create an icon in the
  280. Workbench window. The Image object is used to create the icon image.
  281. Icon objects are configured with the IconWindow.
  282.  
  283.    Icons can be activated in two ways. The user can double-click the
  284. icon or he can select icons on the Workbench and drop them on the icon.
  285. Whenever the icon is activated the Exec object and the Sound object are
  286. activated. The icons which have been dropped onto the icon are used as
  287. startup parameter for the program.
  288.  
  289. Button windows
  290. ==============
  291.  
  292.    A Dock object is a compound object which presents a window with
  293. button rows to the user. Each button binds an Exec objects, an Image
  294. objects and a Sound objects together. Each button can display either a
  295. text, an image or both. The name of the Exec object is used for the
  296. text. The Image object is used to for the image. Dock objects are
  297. configured with the DockWindow.
  298.  
  299.    Each button can be activated in two ways. The user can click on the
  300. button or he can select icons on the Workbench and drop them on the
  301. button. Whenever the icon is activated the Exec object and the Sound
  302. object are activated. The selected icons are used as startup parameter
  303. for the program.
  304.  
  305.    A Dock object can be "activated" with a Hotkeys. When the dock
  306. window is closed and the user enters the hotkey then the dock window is
  307. opened and vice versa.
  308.  
  309.    If the screennotify.library is installed then ToolManager can open
  310. and close dock windows automatically. Every time a screen is going to
  311. be closed all dock windows on this screen are closed first. When the
  312. public screen opens again all dock windows for this screen are opened
  313. again.
  314.  
  315. How to configure ToolManager
  316. ****************************
  317.  
  318.    The ToolManager preferences editor is used to configure ToolManager.
  319.  
  320.    The preferences editor understands the standard Workbench tool types
  321. and Shell command parameters:
  322.  
  323. FROM (Shell only)
  324.      Specifies the file name from which the editor should load the
  325.      configuration.
  326.  
  327. EDIT (default)
  328.      Edit the configuration.
  329.  
  330. USE
  331.      Use the specified configuration temporarily.
  332.  
  333. SAVE
  334.      Use the specified configuration permanently.
  335.  
  336. CREATEICONS
  337.      Create icons for the configuration files when they are saved. When
  338.      started from Workbench the preferences editor creates icons by
  339.      default. When started from the shell no icons are created by
  340.      default.
  341.  
  342. The main window
  343. ===============
  344.  
  345.    The main window contains the object lists. By clicking on the object
  346. type you can select which list is currently visible. Each list can
  347. contain several groups. Each group can hold several objects.
  348.  
  349.    A double-click on the name of a group opens the GroupWindow.
  350. Clicking on the symbol left to the group name opens and closes the
  351. group. If a group is open you can see all the objects in this group. A
  352. double-click on the name of an object opens the object edit window.
  353.  
  354.    To move a group you first select one, drag it to the new position
  355. while holding the left mouse button and then release the mouse button.
  356. You can also move objects between groups with this method.
  357.  
  358.    Attached to the list are four buttons:
  359.  
  360. New Group
  361.      Creates a new empty group. The GroupWindow will open so that you
  362.      can set the name of the new group.
  363.  
  364. New Object
  365.      Create a new object in the selected group. The object edit window
  366.      will open so that you can edit the properties of the new object.
  367.  
  368. Delete
  369.      Deletes the selected group or object. If a group is selected also
  370.      all objects in this group will be deleted.
  371.  
  372. Sort
  373.      If an object or an open group is selected then the contents of
  374.      this group are sorted alphabetically. Otherwise the groups are
  375.      sorted alphabetically.
  376.  
  377.    With the buttons at the bottom of the main window you can tell the
  378. preferences editor where to store the configuration. The name of the
  379. configuration file is ToolManager.prefs.
  380.  
  381. Save
  382.      Store the configuration to ENVARC: and ENV:. The new
  383.      configuration will be taken into use automatically and survive a
  384.      reboot. After storing the preferences editor exits.
  385.  
  386. Use
  387.      Store the configuration to ENV:. The new configuration will be
  388.      taken into use automatically but it will not survive a reboot.
  389.      After storing the preferences editor exits.
  390.  
  391. Test
  392.      Store the configuration to ENV:. The new configuration will be
  393.      taken into use automatically but it will not survive a reboot.
  394.      The preferences editor does not exit.
  395.  
  396. Cancel
  397.      The preferences editor exits. All changes which have not been
  398.      saved will be discarded.
  399.  
  400. How to configure Exec objects
  401. =============================
  402.  
  403.    Exec objects contain information about programs. The edit window has
  404. the following gadgets:
  405.  
  406. Name
  407.      Name of the object.
  408.  
  409. Exec Type
  410.      Type of the program. You can choose between Shell, Workbench,
  411.      ARexx, Dock, Hotkey and Network. The type Network is currently not
  412.      supported.
  413.  
  414. Command
  415.      The name of the program. This is either the file name, the name of
  416.      a dock objects or a hotkey description depending on the Exec Type.
  417.  
  418. Hotkey
  419.      A Hotkeys desciption string which activates this Exec object.
  420.  
  421. Stack
  422.      The stack size for the program. ToolManager will enforce a minimum
  423.      size of 4096 bytes.
  424.  
  425. Priority
  426.      The priority for the program. Usually you should only use the
  427.      default value 0.
  428.  
  429. Arguments
  430.      If this gadget is selected then files are forwarded to the program
  431.      as startup arguments. Otherwise the files are ignored.
  432.  
  433. To Front
  434.      If this gadget is selected then the specified public screen is
  435.      moved to front before starting the program.
  436.  
  437. Current Directory
  438.      The program is started from this directory.
  439.  
  440. Path
  441.      You can here supply a list of directories (separated with
  442.      semicolons) which is used by shell programs to search for other
  443.      programs.
  444.  
  445. Output File
  446.      The output of shell programs is redirected to this file. If you
  447.      specify a console window here then the ouput and the input of the
  448.      shell program is redirected to this window.
  449.  
  450. Public Screen
  451.      Specifies the public screen which will be moved to the front
  452.      before starting the programm.
  453.  
  454. How to configure Image objects
  455. ==============================
  456.  
  457.    Image objects contain information about images. The edit window has
  458. the following gadgets:
  459.  
  460. Name
  461.      Name of the object.
  462.  
  463. File
  464.      The name of the file from which the image data should be loaded.
  465.      Usually you have to remove the ending .info if you want to load
  466.      an icon file.
  467.  
  468. How to configure Sound objects
  469. ==============================
  470.  
  471.    Sound objects contain information about sounds. The edit window has
  472. the following gadgets:
  473.  
  474. Name
  475.      Name of the object.
  476.  
  477. Command
  478.      The ARexx command which should be send to the external sound
  479.      player.
  480.  
  481. ARexx Port
  482.      The ARexx port name of the external sound player. The default is
  483.      PLAY which is used by the program upd.
  484.  
  485. How to configure Menu objects
  486. =============================
  487.  
  488.    Menu objects contain information about entries in the Workbench Tools
  489. menu. The edit window has the following gadgets:
  490.  
  491. Name
  492.      Name of the object. This is also used to create the menu entry.
  493.  
  494. Exec Object
  495.      Link to the attached Exec objects. Use Drag&Drop from the
  496.      MainWindow or a ClipWindow to attach an object. You can edit the
  497.      attached object by clicking on it.
  498.  
  499. Sound Object
  500.      Link to the attached Sound objects. Use Drag&Drop from the
  501.      MainWindow or a ClipWindow to attach an object. You can edit the
  502.      attached object by clicking on it.
  503.  
  504. How to configure Icon objects
  505. =============================
  506.  
  507.    Icon objects contain information about icons in the Workbench window.
  508. The edit window has the following gadgets:
  509.  
  510. Name
  511.      Name of the object.
  512.  
  513. Exec Object
  514.      Link to the attached Exec objects. Use Drag&Drop from the
  515.      MainWindow or a ClipWindow to attach an object. You can edit the
  516.      attached object by clicking on it.
  517.  
  518. Image Object
  519.      Link to the attached Image objects. Use Drag&Drop from the
  520.      MainWindow or a ClipWindow to attach an object. You can edit the
  521.      attached object by clicking on it.
  522.  
  523. Sound Object
  524.      Link to the attached Sound objects. Use Drag&Drop from the
  525.      MainWindow or a ClipWindow to attach an object. You can edit the
  526.      attached object by clicking on it.
  527.  
  528. Position
  529.      Specifies the X and Y coordinates of the icon, e.g. for X =
  530.      100 and Y = 55 you would enter 100/55. The coordinates are
  531.      relative to the top left corner of the Workbench window.
  532.  
  533. Show Name
  534.      If this gadget is selected then the name of the object is shown
  535.      below the icon.
  536.  
  537. How to configure Dock objects
  538. =============================
  539.  
  540.    Dock objects contain information about dock windows. The edit window
  541. has the following gadgets:
  542.  
  543. Name
  544.      Name of the object. This also used as window title.
  545.  
  546. Hotkey
  547.      A Hotkeys desciption string which open and closes the dock window.
  548.  
  549. Public Screen
  550.      Specifies the public screen on which the dock window appears. You
  551.      must specify a valid public screen name if you want to use the
  552.      automatic open and close feature for dock windows.
  553.  
  554. Font
  555.      Use this font for the button texts.
  556.  
  557. Columns
  558.      Number of button columns in the dock window. Columns will be
  559.      filled with buttons from left to right. If the last column in a
  560.      row is filled then a new button row is added. All buttons will
  561.      have the same width and height.
  562.  
  563. Position
  564.      Specifies the X and Y coordinates of the dock window, e.g. for
  565.      X = 150 and Y = 200 you would enter 150/200. The coordinates
  566.      are relative to the top left corner of the screen.
  567.  
  568. Entries
  569.      Each entry in this list creates one button. The left column
  570.      contains the link to the attached Exec objects, the middle column
  571.      the link to the attached Image objects and the right column the
  572.      link to the attached Sound objects. Use Drag&Drop from the
  573.      MainWindow or a ClipWindow to attach an object. You can edit the
  574.      attached objects by double-clicking on them. You can use Drag&Drop
  575.      to sort the entries in the list. When you press the Delete button
  576.      the currently selected entry is removed from the list. The
  577.      attached objects itself are not deleted.
  578.  
  579. Activated
  580.      The dock window will be opened when the configuration is loaded.
  581.  
  582. Backdrop
  583.      The dock window is moved to the back after it has been opened.
  584.  
  585. Border
  586.      When this gadget is selected the dock window looks like a normal
  587.      window with a border and window gadgets. Otherwise it will have no
  588.      border at all. Note that you can move the dock window only if it
  589.      has a border.
  590.  
  591. Menu
  592.      A menu is attached to the dock window. The menu allows you to
  593.      close the dock window, start the ToolManager Preferences or to quit
  594.      ToolManager.
  595.  
  596. Frontmost
  597.      When this gadget is selected then the dock window will always open
  598.      on the frontmost public screen.
  599.  
  600. Pop Up
  601.      The dock window closes automatically after a button has been
  602.      selected.
  603.  
  604. Centered
  605.      The dock window opens centered around the current mouse position.
  606.  
  607. Sticky
  608.      Usually a dock window remembers its position when you close it. It
  609.      will open on this position if you open it again. If this gadget is
  610.      selected then the dock window will always open at the same
  611.      position.
  612.  
  613. Images
  614.      The buttons in the dock window will display images. Note that you
  615.      have to attach Image objects to the dock entries in this case.
  616.  
  617. Text
  618.      The buttons in the dock window will display the name of the
  619.      attached Exec objects. Note that you have to attach Exec objects
  620.      to the dock entries in this case.
  621.  
  622. How to rename an object group
  623. =============================
  624.  
  625.    You can change the name of the group with the name string gadget.
  626.  
  627. Clipboard for objects
  628. =====================
  629.  
  630.    This window contains a list with attached Exec objects, Image
  631. objects and Sound objects. You can drag objects from this list and drop
  632. them on edit windows. You can edit the attached objects by
  633. double-clicking them. When you press the Delete button the currently
  634. selected object is removed from the list. The object itself is not
  635. deleted.
  636.  
  637.    The clipboard can be opened from the menu in the main window. You
  638. can have several clipboards open at once.
  639.  
  640. Global ToolManager options
  641. ==========================
  642.  
  643.    This window lets you change the global options of ToolManager. It
  644. can be opened from the menu in the main window. It has the following
  645. gadgets:
  646.  
  647. Current Directory
  648.      Set the current directory for the ToolManager process. All files
  649.      without an absolute path name will be opened relative to this
  650.      directory. The default directory is the boot volume.
  651.  
  652. Preferences editor
  653.      Path of the ToolManager Preferences binary. The default is
  654.      SYS:Prefs/ToolManager.
  655.  
  656. Enable Network
  657.      Currently not supported.
  658.  
  659. Enable Remap
  660.      Enable colour remapping for picture.datatype. Disable this only if
  661.      you the images in the dock windows come up with the wrong colours.
  662.  
  663. Remap Precision
  664.      Sets the precision of the colour remapping. You might try change
  665.      this value if the colour choices of the remap algorithm are
  666.      unsatisfactory on your system.
  667.  
  668. How to define a Hotkey
  669. **********************
  670.  
  671.    This chapter describes how to define a Hotkey as an Input
  672. Description String, which is then parsed by Commodities. Each time a
  673. Hotkey is activated Commodities generates an event which is used by
  674. ToolManager to activate Exec objects or to toggle Dock objects. A
  675. description string has the following syntax:
  676.  
  677.      [<class>] {[-][<qualifier>]} [-][upstroke] [<key code>]
  678.  
  679.    All keywords are case insensitive.
  680.  
  681.        class describes the InputEvent class. This parameter is
  682. optional and if it is missing the default rawkey is used. See
  683. InputEvent classes.
  684.  
  685.    Qualifiers are "signals" that must be set or cleared by the time the
  686. Hotkey is activated; otherwise no event will be generated. For each
  687. qualifier that must be set you supply its keyword. All other qualifiers
  688. are expected to be cleared by default. If you want to ignore a
  689. qualifier, just set a - before its keyword. See Qualifiers.
  690.  
  691.    A Hotkey event is usually generated when a key is pressed. If the
  692. event should be generated when the key is released, supply the keyword
  693. upstroke. When both press and release of the key should generate an
  694. event, use -upstroke.
  695.  
  696.    The key code is depending on the InputEvent class. See Key codes.
  697.  
  698.    Note: Choose your Hotkeys carefully, because Commodities has a high
  699. priority in the InputEvent handler chain, i.e. it will override existing
  700. definitions.
  701.  
  702. InputEvent classes
  703. ==================
  704.  
  705.    Commodities supports most of the InputEvent classes that are
  706. generated by the input.device. This section describes those classes
  707. that are most useful for ToolManager Hotkeys.
  708.  
  709. rawkey
  710.      This is the default class and covers all keyboard events. For
  711.      example rawkey a or a creates an event every time when the key
  712.      "a" is pressed. You must specify a key code for this class.  See
  713.      rawkey key codes.
  714.  
  715. rawmouse
  716.      This class describes all mouse button events. You must specify a
  717.      key code for this class. See rawmouse key codes.
  718.  
  719. diskinserted
  720.      Events of this class are generated when a disk is inserted in a
  721.      drive. This class has no key codes.
  722.  
  723. diskremoved
  724.      Events of this class are generated when a disk is removed from a
  725.      drive. This class has no key codes.
  726.  
  727. Qualifiers
  728. ==========
  729.  
  730.    Commodities supports the following qualifiers:
  731.  
  732. lshift, left_shift
  733.      Left shift key
  734.  
  735. rshift, right_shift
  736.      Right shift key
  737.  
  738. shift
  739.      Either shift key
  740.  
  741. capslock, caps_lock
  742.      Caps lock key
  743.  
  744. caps
  745.      Either shift key or caps lock key
  746.  
  747. control, ctrl
  748.      Control key
  749.  
  750. lalt, left_alt
  751.      Left alt key
  752.  
  753. ralt, right_alt
  754.      Right alt key
  755.  
  756. alt
  757.      Either alt key
  758.  
  759. lcommand, lamiga, left_amiga, left_command
  760.      Left Amiga/Command key
  761.  
  762. rcommand, ramiga, right_amiga, right_command
  763.      Right Amiga/Command key
  764.  
  765. numericpad, numpad, num_pad, numeric_pad
  766.      This keyword must be used for any key on the numeric pad.
  767.  
  768. leftbutton, lbutton, left_button
  769.      Left mouse button
  770.  
  771. midbutton, mbutton, middlebutton, middle_button
  772.      Middle mouse button
  773.  
  774. rbutton, rightbutton, right_button
  775.      Right mouse button
  776.  
  777. repeat
  778.      This qualifier is set when the keyboard repeat is active. This is
  779.      only useful for the InputEvent class rawkey.
  780.  
  781. Key codes
  782. =========
  783.  
  784.    Each InputEvent class has its own key codes:
  785.  
  786. Key codes for InputEvent class rawkey
  787. -------------------------------------
  788.  
  789. a-z, 0-9, ...
  790.      ASCII characters
  791.  
  792. f1, f2, ..., f10, f11, f12
  793.      Function keys
  794.  
  795. up, cursor_up, down, cursor_down
  796. left, cursor_left, right, cursor_right
  797.      Cursor keys
  798.  
  799. esc, escape, backspace, del, help
  800. tab, comma, return, space, spacebar
  801.      Special keys
  802.  
  803. enter, insert, delete
  804. page_up, page_down, home, end
  805.      Numeric Pad keys. Each of these key codes must be used with the
  806.      numericpad qualifier keyword!
  807.  
  808. Key codes for InputEvent class rawmouse
  809. ---------------------------------------
  810.  
  811. mouse_leftpress
  812.      Press left mouse button
  813.  
  814. mouse_middlepress
  815.      Press middle mouse button
  816.  
  817. mouse_rightpress
  818.      Press right mouse button
  819.  
  820.    Note: To use one of these key codes, you must also set the
  821. corresponding qualifier keyword, e.g.
  822.  
  823.      rawmouse leftbutton mouse_leftpress
  824.  
  825. Examples for Hotkeys
  826. ====================
  827.  
  828. ralt t
  829.      Hold right Alt key and press "t"
  830.  
  831. ralt lalt t
  832.      Hold left and right Alt key and press "t"
  833.  
  834. alt t
  835.      Hold either Alt key and press "t"
  836.  
  837. rcommand f2
  838.      Hold right Amiga key and press the second function key
  839.  
  840. numericpad enter
  841.      Press the Enter key on the numeric pad
  842.  
  843. rawmouse midbutton leftbutton mouse_leftpress
  844.      Hold middle mouse button and press the the left mouse button
  845.  
  846. diskinserted
  847.      Insert a disk in any drive
  848.  
  849. Frequently asked questions
  850. **************************
  851.  
  852.    Here are the answers to the most asked questions about ToolManager:
  853.  
  854.    - When I start the ToolManager preferences editor only a requester
  855.      with the text "Program initialization failed" appears. What's
  856.      wrong?
  857.  
  858.      The preferences editor checks the basic requirements before
  859.      opening the first window. Please check that these Requirements are
  860.      fulfilled! Your system might also be running out of memory. You may
  861.      have to quit some other applications first before enough memory is
  862.      available to run the ToolManager preferences editor. Also there
  863.      can be only one preferences editor running at one time.
  864.  
  865.    - How can I run the ToolManager preferences editor on another public
  866.      screen than the Workbench screen?
  867.  
  868.      Select the entry MUI... from the settings menu in the MainWindow
  869.      menu. Now select the System settings page and enter the name of
  870.      the public screen into the string gadget. For further details
  871.      please consult the MUI documentation.
  872.  
  873.    - After converting my old ToolManager 2.x configuration some pictures
  874.      are missing in the dock windows and some dock windows don't appear
  875.      at all!
  876.  
  877.      ToolManager 3.1 only supports picture files in dock windows which
  878.      can be accessed via the picture.datatype. In your old
  879.      configuration you have attached some Image objects to the Dock
  880.      objects which refer to icon files. In order to use icon files you
  881.      have to install an icon datatype on your system. You may find such
  882.      a datatype e.g. on the Aminet. You can also convert them to e.g.
  883.      IFF Brushes.
  884.  
  885.    - After converting my old ToolManager 2.x configuration some of the
  886.      icons in the Workbench window are missing!
  887.  
  888.      ToolManager 3.1 only supports icons files for Icon objects. In
  889.      your old configuration you have attached some Image objects to the
  890.      Icon objects which refer to IFF Brushes. You have to convert them
  891.      to icon files in order to use them with ToolManager 3.1 Icon
  892.      objects.
  893.  
  894.    - When I use icon files for images in the dock windows then there are
  895.      some addtional texts attached to the image or it has a thick
  896.      border.  What's wrong?
  897.  
  898.      You have installed an icon.datatype on your system which inserts
  899.      additional information from the icon into the image. Please check
  900.      the documentation of the icon.datatype how this information can be
  901.      suppressed. If you don't like the thick border you also have to
  902.      tell the icon.datatype not to generate the usual icon borders.
  903.  
  904.    - Why can't ToolManager create multiple "Tools" menus or sub-menus?
  905.  
  906.      Multiple menus or sub-menus are currently not supported by the
  907.      Workbench.  To create them, you have to hack them into the
  908.      AmigaOS, which can result in an unstable system. Therefore I won't
  909.      implement it in ToolManager.
  910.  
  911.    - How can I create a horizontal dock window?
  912.  
  913.      Just set the number of columns to the number of entries in the
  914.      dock object.
  915.  
  916.    - How can I create an output window for shell programs?
  917.  
  918.      Output windows can be created by using the CON: device. Use the
  919.      following file name to create an auto-open window with a close
  920.      gadget which doesn't close after the program has quit:
  921.  
  922.           CON:10/10/640/100/Output-Window/AUTO/CLOSE/WAIT
  923.  
  924.      The CON: device has many options, please consult your AmigaDOS
  925.      manual for further information.
  926.  
  927.    - How can I put the arguments in the middle of a Shell/Arexx command
  928.      line?
  929.  
  930.      Usually all arguments are appended to the command line. To insert
  931.      the arguments anywhere in the command line, ToolManager uses the
  932.      same [] syntax, which is used by the AmigaShell command
  933.      alias. So for example
  934.  
  935.           Dir [] all
  936.  
  937.      will insert all arguments before the keyword all.
  938.  
  939.    - How can I create sub-docks?
  940.  
  941.      You must use Exec objects of the type Dock. Put such objects in
  942.      the entries of your main dock and they will open/close the other
  943.      docks.
  944.  
  945.    - The dock windows disappear when the Workbench screen is closed and
  946.      opened again.
  947.  
  948.      You have forgotten to set the public screen name for the dock
  949.      window to Workbench. ToolManager will close dock windows when
  950.      the public screen closes. But it has to know on which public
  951.      screen the dock windows should appear in order to open them
  952.      automatically when the public screen opens again.
  953.  
  954. History of ToolManager
  955. **********************
  956.  
  957. 3.1, Release date 01.06.1998
  958.         - Clipboard list also shows the object type now
  959.  
  960.         - Only requires locale.libary V38 now
  961.  
  962.         - Icon drop corrected for dock windows with borders
  963.  
  964.         - The __geta4 qualifier was missing for some BOOPSI
  965.           dispatchers. This might correct some strange bugs which were
  966.           reported?
  967.  
  968.         - Installer script now checks for required libraries
  969.  
  970. 3.0, Release date 23.02.1997
  971.         - Again rewritten (almost) from scratch :-)
  972.  
  973.         - Old object system removed, TM objects are now BOOPSI objects
  974.  
  975.         - Now uses memory pools
  976.  
  977.         - Delay parameter removed from Exec Objects
  978.  
  979.         - Animation support removed from Image Objects
  980.  
  981.         - Picture.datatype V43 support added to Image Objects
  982.  
  983.         - Only icon images supported for Icon Objects
  984.  
  985.         - Only images loadable via picture.datatype are supported in
  986.           Dock Objects
  987.  
  988.         - Pattern & Vertical flags and Title parameter removed from
  989.           Dock Objects
  990.  
  991.         - Dock Objects can now display text and images
  992.  
  993.         - Dock Objects can now be completely borderless
  994.  
  995.         - New preferences file format, hopefully more flexible
  996.  
  997.         - Converter for the ToolManager 2.x format
  998.  
  999.         - Events are now checked while the configuration is read
  1000.  
  1001.         - Preferences is now a MUI application: resizable window,
  1002.           multiple open edit windows and Drag&Drop support
  1003.  
  1004.         - Changing an object name automatically updates all references
  1005.           to the object.
  1006.  
  1007.         - Support for grouping objects.
  1008.  
  1009.         - All dock objects get the screen notifications
  1010.  
  1011.         - Added support for DOSPath 1.0
  1012.  
  1013.         - CLI command lines are not limited to 4KB anymore
  1014.  
  1015.         - Installer script
  1016.  
  1017. 2.1b, Release date 13.03.1996
  1018.         - Minor update to 2.1
  1019.  
  1020.         - Added support for WBStart 2.0
  1021.  
  1022. 2.1a, Release date 26.03.1995
  1023.         - Minor update to 2.1
  1024.  
  1025.         - Added support for ScreenNotify 1.0
  1026.  
  1027.         - Included newer version of WBStart-Handler
  1028.  
  1029.         - Included missing AutoDocs for toolmanager.library
  1030.  
  1031. 2.1, Release date 16.05.1993, Fish Disks #872 & #873
  1032.         - New Exec object types: Dock, Hot Key, Network
  1033.  
  1034.         - New Dock object flags: Backdrop, Sticky
  1035.  
  1036.         - New object type: Access
  1037.  
  1038.         - Network support
  1039.  
  1040.         - Editor main window is now an AppWindow
  1041.  
  1042.         - Gadget keyboard shortcuts in the preferences editor
  1043.  
  1044.         - New tooltypes for the preferences editor
  1045.  
  1046.         - Several bug fixes
  1047.  
  1048.         - Enhanced documentation
  1049.  
  1050. 2.0, Release date 26.09.1992, Fish Disk #752
  1051.         - Complete new concept (object oriented)
  1052.  
  1053.         - (Almost) Complete rewrite
  1054.  
  1055.         - ToolManager is now split up into two parts
  1056.  
  1057.         - Main handler is now embedded into a shared library
  1058.  
  1059.         - Configuration is now handled by a Preferences program
  1060.  
  1061.         - Configuration file format has changed again :-) It is an IFF
  1062.           File now and resides in ENV:
  1063.  
  1064.         - Multiple Docks and multi-column Docks
  1065.  
  1066.         - Docks with new window design
  1067.  
  1068.         - Dock automatically detects largest image size
  1069.  
  1070.         - Sound support
  1071.  
  1072.         - Direct ARexx support for Exec objects
  1073.  
  1074.         - ToolManager can be used without the Workbench. If the
  1075.           Workbench isn't running, it won't use any App* features.
  1076.  
  1077.         - Locale support
  1078.  
  1079.         - Path from Workbench will be used for CLI tools
  1080.  
  1081.         - Seperate Handler Task for starting WB processes
  1082.  
  1083. 1.5, Release date 10.10.1991, Fish Disk #551
  1084.         - Status Window: New/Open/Append/Save As menu items for config
  1085.           file
  1086.  
  1087.         - Edit Window: File requesters for file string gadgets
  1088.  
  1089.         - Added a Dock Window (a la NeXT)
  1090.  
  1091.         - Added a DeleteTool
  1092.  
  1093.         - A list of all active HotKeys can be shown
  1094.  
  1095.         - Tools can be moved around in the list
  1096.  
  1097.         - Icon positioning in the edit window added
  1098.  
  1099.         - Name of the program icon can be set
  1100.  
  1101.         - CLI tools can have an output file and a path list
  1102.  
  1103.         - Uses UserShell for CLI tools
  1104.  
  1105.         - Maximum command line length for CLI tools is now 4096 Bytes
  1106.  
  1107.         - AppIcons without a name are supported now
  1108.  
  1109.         - Workbench screen will be moved to front if you pop up the
  1110.           Status window
  1111.  
  1112.         - Workbench screen can be moved to front before starting a tool
  1113.           via HotKey
  1114.  
  1115.         - TM will wait up to 20 seconds for the workbench.library
  1116.  
  1117.         - Added a DELAY switch which causes TM to wait <num> seconds
  1118.           before adding any App* stuff
  1119.  
  1120.         - renamed some tooltypes/parameters
  1121.  
  1122.         - some visual cues added
  1123.  
  1124.         - some internal changes
  1125.  
  1126. 1.4, Release date 09.07.1991, Fish Disk #527
  1127.         - Keyboard short cuts for tools
  1128.  
  1129.         - AppIcons for tools
  1130.  
  1131.         - Menu item can be switched off
  1132.  
  1133.         - Configuration file format completely changed (hopefully the
  1134.           last time)
  1135.  
  1136.         - CLI commandline parsing is now done by ReadArgs()
  1137.  
  1138.         - Status & edit window updated to new features
  1139.  
  1140.         - Safety check before program shutdown added
  1141.  
  1142.         - Menu item "Open TM Window" only appears if the program icon is
  1143.           disabled
  1144.  
  1145.         - WB startup method changed. Now supports project icons
  1146.  
  1147.         - several internal changes
  1148.  
  1149. 1.3, Release date 13.03.1991, Fish Disk #476
  1150.         - Now supports different configuration files
  1151.  
  1152.         - Format of the configuration file slightly changed
  1153.  
  1154.         - Tool definitions can be changed at runtime
  1155.  
  1156.         - Now supports CLI & Workbench startup method
  1157.  
  1158.         - Selected icons are passed as parameters to the tools
  1159.  
  1160.         - Now uses the startup icon as program icon if started from
  1161.           Workbench
  1162.  
  1163.         - The position of the icon can now be supplied in the
  1164.           configuration file
  1165.  
  1166.         - The program icon can now be disabled
  1167.  
  1168.         - New menu entry "Show TM Window"
  1169.  
  1170.         - Every new started ToolManager passes its startup parameters
  1171.           to the already running ToolManager process
  1172.  
  1173. 1.2, Release date 12.01.1991, Fish Disk #442
  1174.         - Status window changed to a no-GZZ & simple refresh type (this
  1175.           should save some bytes)
  1176.  
  1177.         - Status window remembers its last position
  1178.  
  1179.         - New status window gadget "Save Configuration": saves the
  1180.           actual tool list in the configuration file
  1181.  
  1182.         - Small bugs removed in the ListView gadget handling
  1183.  
  1184.         - Name of the icon hard-wired to "ToolManager"
  1185.  
  1186. 1.1, Release date 01.01.1991
  1187.         - Icons can be dropped on the status window
  1188.  
  1189.         - Status window contains a list of all tool names
  1190.  
  1191.         - Tools can be removed from the list
  1192.  
  1193. 1.0, Release date 04.11.1990
  1194.         - Initial release
  1195.  
  1196. The author would like to thank...
  1197. *********************************
  1198.  
  1199.    ToolManager has gone through many major evolutionary phases since
  1200. its first implementation in mid-1990. This development would have been
  1201. impossible if I hadn't received the enormous feedback from various
  1202. ToolManager users. Many ideas & features resulted from this source...
  1203.  
  1204.    Therefore I would like to thank:
  1205.  
  1206. For Alpha/Beta testing, ideas & bug reports:
  1207.      Osma Ahvenlampi, Stephane Barbaray, Olaf Barthel, Fionn Behrens,
  1208.      Mario Cattaneo, Michael van Elst, Michael Hohmann, Markus
  1209.      Illenseer, Frank Mariak, Klaus Melchior, Bernhard Moellemann,
  1210.      Matthias Scheler, Ralph Schmidt, Tobias Walter.
  1211.  
  1212. For the translations:
  1213.      The Amiga Translators Organization (ATO). Please check the file
  1214.      Readme.Locale for the list of translators.
  1215.  
  1216. Matthew Dillon
  1217.      Without your excellent C development system DICE and various
  1218.      other tools, ToolManager wouldn't exist!
  1219.  
  1220. All users who sent me money:
  1221.      Your support made this release possible.
  1222.  
  1223. All users who sent me a note:
  1224.      I really enjoyed reading your letters and E-Mails!
  1225.  
  1226.    ToolManager uses the following packages:
  1227.  
  1228. picture.datatype V43
  1229.      Copyright (C) 1995-1996 Ralph Schmidt, Frank Mariak &
  1230.      Matthias Scheler
  1231.  
  1232. WBStart 2.2
  1233.      Copyright (C) 1991-1996 Stefan Becker
  1234.  
  1235. ScreenNotify 1.0
  1236.      Copyright (C) 1995 Stefan Becker
  1237.  
  1238. DOSPath 1.0
  1239.      Copyright (C) 1996 Stefan Becker
  1240.  
  1241. MUI
  1242.      Copyright (C) 1993-1997 Stefan Stuntz
  1243.      World Wide Web home page: http://www.sasg.com/.
  1244.  
  1245. Pophotkey.mcc, Popport.mcc, Popposition.mcc
  1246.      Copyright (C) 1996-1997 Klaus Melchior
  1247.  
  1248. Icons
  1249.      Copyright (C) 1995 Michael W. Hohmann
  1250.  
  1251. Information about MUI
  1252. *********************
  1253.  
  1254.                                This application uses
  1255.      
  1256.      
  1257.                              MUI - MagicUserInterface
  1258.      
  1259.                      (c) Copyright 1993-97 by Stefan Stuntz
  1260.      
  1261.      
  1262.      MUI is a system to generate and maintain graphical user interfaces. With
  1263.      the  aid  of  a  preferences program, the user of an application has the
  1264.      ability to customize the outfit according to his personal taste.
  1265.      
  1266.      MUI is distributed as shareware. To obtain a complete package containing
  1267.      lots of examples and more information about registration please look for
  1268.      a  file  called  "muiXXusr.lha"  (XX means the latest version number) on
  1269.      your local bulletin boards or on public domain disks.
  1270.      
  1271.                If you want to register directly, feel free to send
  1272.      
  1273.      
  1274.                               DM 30.-  or  US$ 20.-
  1275.      
  1276.                                        to
  1277.      
  1278.                                   Stefan Stuntz
  1279.                              Eduard-Spranger-Straße 7
  1280.                                   80935 München
  1281.                                      GERMANY
  1282.      
  1283.      
  1284.      
  1285.                   Support and online registration is available at
  1286.      
  1287.                                http://www.sasg.com/
  1288.  
  1289. Index
  1290. *****
  1291.  
  1292.  
  1293.  
  1294.  Addresses                              Author
  1295.  Author                                 Author
  1296.  Concepts                               Concepts
  1297.  Contact addresses                      Author
  1298.  Copyright                              Copyright
  1299.  Credits                                Credits
  1300.  DataTypes                              Requirements
  1301.  Diskinserted                           InputEvent classes
  1302.  Diskremoved                            InputEvent classes
  1303.  Distribution                           Copyright
  1304.  Dock objects                           Dock objects
  1305.  Donations                              GiftWare
  1306.  DOSPath                                Requirements
  1307.  EMail                                  Author
  1308.  Examples for Hotkeys                   Hotkey examples
  1309.  Exec objects                           Exec objects
  1310.  Future                                 Future
  1311.  GiftWare                               GiftWare
  1312.  Homepage                               Author
  1313.  Hotkeys                                Hotkeys
  1314.  Icon objects                           Icon objects
  1315.  Image objects                          Image objects
  1316.  InputEvent classes                     InputEvent classes
  1317.  Installation                           Installation
  1318.  Installer V43.3                        Installation
  1319.  Introduction to Hotkeys                Hotkeys
  1320.  Key codes for rawkey                   rawkey key codes
  1321.  Key codes for rawmouse                 rawmouse key codes
  1322.  Legal stuff                            Copyright
  1323.  Menu objects                           Menu objects
  1324.  MUI                                    MUI
  1325.  OS 3.0                                 Requirements
  1326.  Permissions                            Copyright
  1327.  PictDT V43                             Requirements
  1328.  Pophotkey                              Requirements
  1329.  Popport                                Requirements
  1330.  Popposition                            Requirements
  1331.  Post address                           Author
  1332.  Preferences                            Preferences
  1333.  Probibitions                           Copyright
  1334.  Qualifiers                             Qualifiers
  1335.  Rawkey                                 InputEvent classes
  1336.  Rawmouse                               InputEvent classes
  1337.  Requirements                           Requirements
  1338.  ScreenNotify                           Requirements
  1339.  Sound objects                          Sound objects
  1340.  Thanks                                 Credits
  1341.  V39                                    Requirements
  1342.  WBStart                                Requirements
  1343.  Word Wide Web                          Author
  1344.  
  1345.